[CloudSyncMgr] Renaming the CloudSyncMgr API according to functionality to add more APIs #483

nitu-s-gupta · 2022-02-17T09:58:24Z

Description

The APIs were names as per the naming convection followed for previous APIs as for example, APIV1Request<><<GET/POST>> But with multiple APIs being added going further in CloudSyncMgr it is necessary to modify the API in terms of functionality i.e publish, subscribe

Fixes # (#382 )

Type of change

Please delete options that are not relevant.

Code cleanup/refactoring

How Has This Been Tested?

1.MQTT mosquitto broker is configured to be running in the AWS endpoint.
2. The edge orchestration is build and run using following command with option CLOUD_SYNC set to true

docker run -it -d --privileged --network="host" --name edge-orchestration -e CLOUD_SYNC=true -v /var/edge-orchestration/:/var/edge-orchestration/:rw -v /var/run/docker.sock:/var/run/docker.sock:rw -v /proc/:/process/:ro  lfedge/edge-home-orchestration-go:latest

From the another terminal/post make a curl command as follows to publish data using home edge to the broker running on AWS endpoint

curl --location --request POST 'http://192.168.1.107:56001/api/v1/orchestration/cloudsyncmgr/publish' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "appid": "testsamsung",
    "payload": "Testdata for subscribing",
    "topic": "homeedge/livingroom",
    "url" : "ec2-184-73-83-74.compute-1.amazonaws.com"
}'

4.You should obtain the following message for successful publish

{"Message":"Data published successfully to Cloud","RemoteTargetInfo":"","ServiceName":""}

The Broker logs are checked in AWS and we observe following logs

1641480800: New connection from 49.207.219.60 on port 1883.
1641480800: New client connected from 49.207.219.60 as com.nokia.homeedge1 (p2, c1, k30).
1641480800: No will message specified.
1641480800: Sending CONNACK to com.nokia.homeedge1 (0, 0)
1641480800: Received PUBLISH from com.nokia.homeedge1 (d0, q0, r1, m0, 'home1/livingroom', ... (80 bytes))
1641480830: Received PINGREQ from com.nokia.homeedge1
1641480830: Sending PINGRESP to com.nokia.homeedge1
1641480850: Received PUBLISH from com.nokia.homeedge1 (d0, q0, r1, m0, 'home1/livingroom', ... (73 bytes))

Same client sending data but connection is established only once.

Test Configuration:

OS type & version: ( Ubuntu 20.04)
Hardware: (x86-64)
Edge Orchestration Release: (v1.1.0)

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

Signed-off-by: Nitu Gupta <[email protected]>

[Cloudsync] Added testcases to improve the Code coverage for MQTT

tiokim · 2022-02-17T10:04:24Z

internal/controller/cloudsyncmgr/cloudsync.go

@@ -36,7 +36,7 @@ const (
 type CloudSync interface {
 	InitiateCloudSync(isCloudSet string) error
 	//implemented by external REST API
-	RequestCloudSyncConf(host string, clientID string, message mqttmgr.Message, topic string) string
+	RequestCloudSyncPublish(host string, clientID string, message mqttmgr.Message, topic string) string


Simply, what about Publish?

Do you mean just Publish(), I thought of this idea, but then thought would be confusing for nay neww developer to understand by just Publish and hence this name.

However this function is in the CloudSync. What about RequestPublish instead?

tiokim · 2022-02-18T06:02:04Z

Please correct How Has This Been Tested?.
I think you should fix the document as well.

nitu-s-gupta · 2022-02-18T09:12:47Z

Please correct How Has This Been Tested?. I think you should fix the document as well.

Done!!!

suresh-lc

+1

nitu-s-gupta · 2022-02-21T12:20:01Z

@t25kim @MoonkiHong @tdrozdovsky PTAL 🙏

tdrozdovsky

Please change

internal/orchestrationapi/mocks/mock_orchestration.go

tdrozdovsky · 2022-02-21T12:34:39Z

Please change:
docs/secure_manager.md:
Line 225: | /api/v1/orchestration/cloudsyncmgr | Allow | Allow | => | /api/v1/orchestration/cloudsyncmgr/publish | Allow | Allow |
Line 248: p, member, /api/v1/orchestration/cloudsyncmgr, * => p, member, /api/v1/orchestration/cloudsyncmgr/publish, *
internal/controller/securemgr/authorizer/authorizer.go:
Line 39: "p, member, /api/v1/orchestration/cloudsyncmgr, *\n" => "p, member, /api/v1/orchestration/cloudsyncmgr/publish, *\n
internal/restinterface/externalhandler/externalhandler_test.go
Line:292: func TestAPIV1RequestCloudSyncmgrPost(t *testing.T) { => func TestAPIV1RequestCloudSyncmgrPublish(t *testing.T) {

internal/orchestrationapi/mocks/mock_orchestration.go

nitu-s-gupta · 2022-02-21T14:08:53Z

Please change: docs/secure_manager.md: Line 225: | /api/v1/orchestration/cloudsyncmgr | Allow | Allow | => | /api/v1/orchestration/cloudsyncmgr/publish | Allow | Allow | Line 248: p, member, /api/v1/orchestration/cloudsyncmgr, * => p, member, /api/v1/orchestration/cloudsyncmgr/publish, * internal/controller/securemgr/authorizer/authorizer.go: Line 39: "p, member, /api/v1/orchestration/cloudsyncmgr, *\n" => "p, member, /api/v1/orchestration/cloudsyncmgr/publish, *\n internal/restinterface/externalhandler/externalhandler_test.go Line:292: func TestAPIV1RequestCloudSyncmgrPost(t *testing.T) { => func TestAPIV1RequestCloudSyncmgrPublish(t *testing.T) {

Done!!

…ublish Signed-off-by: Nitu Gupta <[email protected]>

sonarcloud · 2022-02-21T14:22:45Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
2.9% Duplication

tdrozdovsky

+1

tiokim

LGTM Thanks!

MoonkiHong

LGTM.

nitu-s-gupta and others added 5 commits January 31, 2022 11:57

[Cloudsync] Added testcases to improve the Code coverage

123cf4b

Signed-off-by: Nitu Gupta <[email protected]>

Merge pull request lf-edge#458 from nitu-s-gupta/coverage

5f3b330

[Cloudsync] Added testcases to improve the Code coverage for MQTT

Merge branch 'lf-edge:master' into master

0600306

Merge branch 'lf-edge:master' into master

90b5cbc

Merge branch 'lf-edge:master' into master

24f810f

nitu-s-gupta requested review from tiokim, MoonkiHong, suresh-lc and tdrozdovsky as code owners February 17, 2022 09:58

boring-cyborg bot added the base code label Feb 17, 2022

nitu-s-gupta changed the title ~~Renaming the CloudSyncMgr API according to functionality to add more APIs~~ [CloudSyncMgr] Renaming the CloudSyncMgr API according to functionality to add more APIs Feb 17, 2022

tiokim reviewed Feb 17, 2022

View reviewed changes

nitu-s-gupta force-pushed the publish branch from 0850f44 to 817c45d Compare February 18, 2022 05:44

nitu-s-gupta force-pushed the publish branch from 817c45d to 6154e42 Compare February 18, 2022 08:23

boring-cyborg bot added the documentation Improvements or additions to documentation label Feb 18, 2022

suresh-lc approved these changes Feb 21, 2022

View reviewed changes

tdrozdovsky requested changes Feb 21, 2022

View reviewed changes

internal/orchestrationapi/mocks/mock_orchestration.go Outdated Show resolved Hide resolved

tdrozdovsky requested changes Feb 21, 2022

View reviewed changes

internal/orchestrationapi/mocks/mock_orchestration.go Outdated Show resolved Hide resolved

nitu-s-gupta force-pushed the publish branch from 6154e42 to 70dc6ec Compare February 21, 2022 13:56

boring-cyborg bot added the security Any tasks and issues w.r.t. the security label Feb 21, 2022

nitu-s-gupta force-pushed the publish branch from 70dc6ec to e81e48a Compare February 21, 2022 14:14

[CloudSync] Renaming the function from CloudSyncMgrPost to CloudSyncP…

0a93094

…ublish Signed-off-by: Nitu Gupta <[email protected]>

nitu-s-gupta force-pushed the publish branch from e81e48a to 0a93094 Compare February 21, 2022 14:21

tdrozdovsky self-requested a review February 21, 2022 14:27

tdrozdovsky approved these changes Feb 21, 2022

View reviewed changes

tiokim approved these changes Feb 21, 2022

View reviewed changes

MoonkiHong approved these changes Feb 23, 2022

View reviewed changes

MoonkiHong merged commit dfd3e6e into lf-edge:master Feb 23, 2022

nitu-s-gupta deleted the publish branch February 24, 2022 08:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CloudSyncMgr] Renaming the CloudSyncMgr API according to functionality to add more APIs #483

[CloudSyncMgr] Renaming the CloudSyncMgr API according to functionality to add more APIs #483

nitu-s-gupta commented Feb 17, 2022 •

edited

Loading

tiokim Feb 17, 2022

nitu-s-gupta Feb 17, 2022

tiokim Feb 17, 2022

nitu-s-gupta Feb 17, 2022

nitu-s-gupta Feb 18, 2022

tiokim commented Feb 18, 2022

nitu-s-gupta commented Feb 18, 2022

suresh-lc left a comment

nitu-s-gupta commented Feb 21, 2022

tdrozdovsky left a comment

tdrozdovsky commented Feb 21, 2022 •

edited

Loading

nitu-s-gupta commented Feb 21, 2022

sonarcloud bot commented Feb 21, 2022

tdrozdovsky left a comment

tiokim left a comment

MoonkiHong left a comment

[CloudSyncMgr] Renaming the CloudSyncMgr API according to functionality to add more APIs #483

[CloudSyncMgr] Renaming the CloudSyncMgr API according to functionality to add more APIs #483

Conversation

nitu-s-gupta commented Feb 17, 2022 • edited Loading

Description

Type of change

How Has This Been Tested?

Checklist:

tiokim Feb 17, 2022

Choose a reason for hiding this comment

nitu-s-gupta Feb 17, 2022

Choose a reason for hiding this comment

tiokim Feb 17, 2022

Choose a reason for hiding this comment

nitu-s-gupta Feb 17, 2022

Choose a reason for hiding this comment

nitu-s-gupta Feb 18, 2022

Choose a reason for hiding this comment

tiokim commented Feb 18, 2022

nitu-s-gupta commented Feb 18, 2022

suresh-lc left a comment

Choose a reason for hiding this comment

nitu-s-gupta commented Feb 21, 2022

tdrozdovsky left a comment

Choose a reason for hiding this comment

tdrozdovsky commented Feb 21, 2022 • edited Loading

nitu-s-gupta commented Feb 21, 2022

sonarcloud bot commented Feb 21, 2022

tdrozdovsky left a comment

Choose a reason for hiding this comment

tiokim left a comment

Choose a reason for hiding this comment

MoonkiHong left a comment

Choose a reason for hiding this comment

nitu-s-gupta commented Feb 17, 2022 •

edited

Loading

tdrozdovsky commented Feb 21, 2022 •

edited

Loading